/*
 * Copyright (c) 2009 DeledImporter
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Pyro Games' nor the names of its contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package net.pyrogames.deled.importer;

import java.io.File;
import java.net.URL;

import net.pyrogames.deled.geometry.DXSNode;

/**
 * Used in conjunction with the <code>DXSImporter</code>, a <code>Format</code>
 * specifies how the DXS scene data should be converted into specific
 * scene data for a 3D java engine, whether it be jMonkey, Ardor3D, etc.
 * <p>
 * Since the specifics are encapsulated outside the importer, users
 * can easily reuse the importer for new versions of an engine
 * or re-use an existing format if the importer needs to be updated
 * with DeleD 3D updates.
 * <p>
 * Users can also easily incorporate their own custom tagged geometry
 * in deled with the use of a custom format class and supplied extensions
 * to the importer. See the <code>{@link DXSImporter}</code> 
 * and <code>{@link DXSExtension}</code> classes.
 * 
 * @author Nicholas Woodfield
 *
 */
public interface Format<E> {
	
	/**
	 * When the format has loaded the model data and
	 * converted it to the appropriate format bearing
	 * no exceptions, return the converted data.
	 * 
	 * @return
	 * 		Return the model data, otherwise null
	 */
	public E getData();
	
	/**
	 * Loads and converts the DXS scene data into
	 * the appropriate format.
	 * 
	 * @param root
	 * 			root node of the dxs scene
	 * @throws ImportException
	 * 			throws an exception if the conversion fails
	 */
	public void loadData(DXSNode root) throws ImportException;
	
	/**
	 * Saves the imported scene to a file.
	 * 
	 * @param dir
	 * 		File pointing to a directory.
	 */
	public void save(File dir);
	
	/**
	 * Set the scale for the loaded data.
	 * 
	 * @param scale
	 * 		float value, where 1.0 is default scale
	 */
	public void setScale(float scale);
	
	/**
	 * Sets the texture directory from where textures will be loaded from
	 * during the conversion.
	 * 
	 * @param dir
	 * 		URL which points to the directory.
	 */
	public void setTextureDirectory(URL dir);
	
	/**
	 * Clears and resets any saved data in this format, so it may be reused.
	 */
	public void flush();
}
